<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Feed_Pubsubhubbub
 * @subpackage Callback
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: CallbackInterface.php 23775 2011-03-01 17:25:24Z ralph $
 */

/**
 * @category   Zend
 * @package    Zend_Feed_Pubsubhubbub
 * @subpackage Callback
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
interface Zend_Feed_Pubsubhubbub_CallbackInterface {
	/**
	 * Handle any callback from a Hub Server responding to a subscription or
	 * unsubscription request. This should be the Hub Server confirming the
	 * the request prior to taking action on it.
	 *
	 * @param array $httpData GET/POST data if available and not in $_GET/POST
	 * @param bool $sendResponseNow Whether to send response now or when asked
	 */
	public function handle(array $httpData = null, $sendResponseNow = false);
	
	/**
	 * Send the response, including all headers.
	 * If you wish to handle this via Zend_Controller, use the getter methods
	 * to retrieve any data needed to be set on your HTTP Response object, or
	 * simply give this object the HTTP Response instance to work with for you!
	 *
	 * @return void
	 */
	public function sendResponse();
	
	/**
	 * An instance of a class handling Http Responses. This is implemented in
	 * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with
	 * (i.e. not inherited from) Zend_Controller_Response_Http.
	 *
	 * @param Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $httpResponse
	 */
	public function setHttpResponse($httpResponse);
	
	/**
	 * An instance of a class handling Http Responses. This is implemented in
	 * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with
	 * (i.e. not inherited from) Zend_Controller_Response_Http.
	 *
	 * @return Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http
	 */
	public function getHttpResponse();
}
